<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#get">get(enterpriseId, productId, language=None)</a></code></p>
<p class="firstline">Retrieves details of a product for display to an enterprise admin.</p>
<p class="toc_element">
  <code><a href="#getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None)</a></code></p>
<p class="firstline">Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.</p>
<p class="toc_element">
  <code><a href="#getPermissions">getPermissions(enterpriseId, productId)</a></code></p>
<p class="firstline">Retrieves the Android app permissions required by this app.</p>
<p class="toc_element">
  <code><a href="#updatePermissions">updatePermissions(enterpriseId, productId, body)</a></code></p>
<p class="firstline">Updates the set of Android app permissions for this app that have been accepted by the enterprise.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="get">get(enterpriseId, productId, language=None)</code>
  <pre>Retrieves details of a product for display to an enterprise admin.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product, e.g. "app:com.google.android.gm". (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Returns:
  An object of the form:

    { # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
      #
      # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.
    "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
    "title": "A String", # The name of the product.
    "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
    "iconUrl": "A String", # A link to an image that can be used as an icon for the product.
    "authorName": "A String", # The name of the author of the product (e.g. the app developer).
    "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
    "productId": "A String", # A string of the form "app:
        # " - e.g. "app:com.google.android.gm" represents the GMail app.
  }</pre>
</div>

<div class="method">
    <code class="details" id="getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None)</code>
  <pre>Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Returns:
  An object of the form:

    { # Represents the list of app restrictions available to be pre-configured for the product.
    "restrictions": [ # The set of restrictions that make up this schema.
      { # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
        "restrictionType": "A String", # The type of the restriction.
        "title": "A String", # The name of the restriction.
        "defaultValue": { # A typed value for the restriction. # The default value of the restriction.
          "valueBool": True or False, # The boolean value - this will only be present if type is bool.
          "valueString": "A String", # The string value - this will be present for types string, choice and hidden.
          "type": "A String", # The type of the value being provided.
          "valueMultiselect": [ # The list of string values - this will only be present if type is multiselect.
            "A String",
          ],
          "valueInteger": 42, # The integer value - this will only be present if type is integer.
        },
        "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values.
          "A String",
        ],
        "key": "A String", # The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
        "entry": [ # For choice or multiselect restrictions, the list of possible entries' human-readable names.
          "A String",
        ],
        "description": "A String", # A longer description of the restriction, giving more detail of what it affects.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="getPermissions">getPermissions(enterpriseId, productId)</code>
  <pre>Retrieves the Android app permissions required by this app.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)

Returns:
  An object of the form:

    { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
      "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
      "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
      "permission": [ # The permissions required by the app.
        { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
            #
            # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
          "permissionId": "A String", # An opaque string uniquely identifying the permission.
          "state": "A String", # Whether the permission has been accepted or not.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="updatePermissions">updatePermissions(enterpriseId, productId, body)</code>
  <pre>Updates the set of Android app permissions for this app that have been accepted by the enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
    "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
    "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
    "permission": [ # The permissions required by the app.
      { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
          #
          # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
        "permissionId": "A String", # An opaque string uniquely identifying the permission.
        "state": "A String", # Whether the permission has been accepted or not.
      },
    ],
  }


Returns:
  An object of the form:

    { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
      "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
      "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
      "permission": [ # The permissions required by the app.
        { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
            #
            # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
          "permissionId": "A String", # An opaque string uniquely identifying the permission.
          "state": "A String", # Whether the permission has been accepted or not.
        },
      ],
    }</pre>
</div>

</body></html>